/****

    activequant - activestocks.eu

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

	
	contact  : contact@activestocks.eu
    homepage : http://www.activestocks.eu

****/
package org.activequant.data.util.converter;

import java.util.List;

import org.activequant.core.domainmodel.data.Candle;
import org.activequant.core.domainmodel.data.TradeIndication;

/**
 * Interface for a strategy that generates (fakes) TradeIndications 
 * from a Candle. There may be many implementation of this strategy,
 * from simple ones, to sophisticated ones (i.e. Linear interpolation,
 * Brownian bridge).
 * <br/>
 * An interface. Defines the following methods:
 * <ul>
 * <li>List&lt;TradeIndication&gt; convert(Candle candle);</li>
 * </ul>
 * <b>History:</b><br>
 *  - [09.30.2008] Created (Mike Kroutikov)<br>
 *
 *  @author Mike Kroutikov
 */
public interface ICandleToTradeIndicationConversion {

	/**
	 * Generates list of trade indications from a given Candle.
	 * Returned List must be sorted by TradeIndication timestamp, so that
	 * oldest one comes first, and newest one is at the end.
	 * 
	 * @param candle source candle.
	 * 
	 * @return list of generated trade indications.
	 */
	List<TradeIndication> convert(Candle candle);
}
